home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr46 / ixref11b.zip / MANUAL.TXT < prev    next >
Text File  |  1993-03-27  |  9KB  |  286 lines
  1.           We strongly recommend that you experiment with the program for
  2. a few minutes before reading this manual.   Try the following commands:
  3.  
  4.  
  5.           Install IXREF by copying 'ixref.exe' to your favorite
  6.           utilities directory.
  7.  
  8.  
  9.  
  10.                      "cd" to any directory with 'C/C++' files
  11.  
  12.  
  13.  
  14.  
  15.                      "ixref *.h *.c *.cpp"
  16.  
  17.  
  18.  
  19.  
  20.                      Press 'F1' for help
  21.  
  22.  
  23.  
  24.           Experiment with the different menus and windows.
  25.  
  26.  
  27.           Position the cursor over any text on the screen and press the
  28.           mouse button.
  29.  
  30.  
  31.           Try the "Tab", "Enter", "Up", "Down", "Page Up", and "Page Down"
  32.           keys in all of the windows and see what happens.
  33.  
  34.  
  35.  
  36.  
  37. ------------------ Introduction.--------------------------------------
  38.  
  39.           Interactive Cross Reference (IXREF) is a simple programming tool that
  40. helps the programmer quickly understand C or C++ source code.  This manual
  41. includes chapters describing how to use this tool.
  42.  
  43.  
  44. Features:
  45.  
  46.           IXREF lets you cross reference C or C++ source code and your text
  47.           files.  It has:
  48.  
  49.           * simple point-and-click action using the mouse or keyboard for
  50.             selection.
  51.  
  52.           * fast database load time.
  53.  
  54.           * easy-to-use interface with standard menu and status line
  55.             layout. If you use Borland IDE, Microsoft PWB, Windows,
  56.             OS/2, or Apple Macintosh before, you can master this software
  57.             interface in seconds.
  58.  
  59.           * support for multiple windows to multiple project database.
  60.  
  61. Requirements:
  62.              * IBM PC or clone with at lease 512K of memory.
  63.  
  64. Supports:
  65.              * EGA/VGA 43/50 lines screens.
  66.              * Mouse.
  67.              * It runs under Window, OS/2 as DOS program.
  68.  
  69.  
  70.  
  71.  
  72. ------------------ CHAPTER 1 Getting Started. ----------------------
  73.  
  74.           This chapter gives you information about how to install
  75. Interactive Cross Reference Tool and convers the basics for starting
  76. the program.
  77.  
  78. ---- Installing Interactive Cross Reference Tool ----
  79.  
  80.           To Install Interactive Cross Reference, just copy the
  81. ixref.exe from the program disk to you favor programming utilities
  82. directory.
  83.  
  84. ---- Starting Interactive Cross Reference Tool ----
  85.  
  86.           Type "ixref" to start the program.  Use one or more of the
  87. following options to build or read an existing database.
  88.  
  89.  
  90. Command Line Options
  91.  
  92.          -------------------------------------------------------------
  93.          Option                Description
  94.          -------------------------------------------------------------
  95.          -x filename.xrf       Load "filename.xrf" cross reference
  96.                                       database.
  97.  
  98.          filename.ext          Read "filename.ext" as source file, then
  99.                                       build the XRF database for the file.
  100.  
  101. Examples:
  102.  
  103.      "IXREF *.H *.CPP"        Builds a cross reference database
  104.                                       for all of the .h and .cpp files in current
  105.                                       directory.
  106.  
  107.  
  108.       Alt-x                   Exits the program.
  109.  
  110.  
  111.  
  112. --------------------
  113. Identifier List Box:
  114. --------------------
  115.      This list box contains all of the identifiers in the source files.
  116.      This list appears on the upper left side of the window.
  117.  
  118.      Special keys in this window pane:
  119.      --------------------------------------------------------------
  120.          UP, DOWN, PAGE UP, PAGE DOWN:  Scroll the identifiers list.
  121.  
  122.          ENTER, "Right Mouse Button":   Enter current selection
  123.                                                   in the History List Box.
  124.  
  125.          Tab:                           Move cursor to the Reference
  126.                                                   List Box.
  127.  
  128.          a,z, A, Z:                     Interactively search for
  129.                                                   case-sensitive identifier string
  130.                                                   in the database.
  131.  
  132.  
  133. -------------------
  134. Reference List Box:
  135. -------------------
  136.      This list box contains all of the references to the current
  137.      identifier in the Identifier List Box. This list appears in
  138.      the upper middle section of the window.
  139.  
  140.      Special Keys in this window pane:
  141.      --------------------------------------------------------------
  142.          UP, DOWN, PAGE UP, PAGE DOWN:  Scroll the identifiers list.
  143.  
  144.          ENTER, "Right Mouse Button":   Enter current selection
  145.                                                   in the History List Box.
  146.  
  147.          Tab:                           Move cursor to the Reference
  148.                                                   List Box.
  149.  
  150.  
  151.  
  152. -----------------
  153. History List Box:
  154. -----------------
  155.           This list box maintains a list of previously referenced items.
  156.           The initially empty list is updated automatically when you
  157.           press "ENTER" while in the various window panes. This list
  158.           appears in the upper right side of the window.
  159.  
  160.  
  161.           Special Keys in this window pane:
  162.           --------------------------------------------------------------
  163.              UP, DOWN, PAGE UP, PAGE DOWN:  Scroll the identifiers list.
  164.                                             As this list is scrolled, the
  165.                                             other lists are automatically
  166.                                             updated.
  167.  
  168.                  Tab:                       Move cursor to the File Viewer
  169.                                             Window.
  170.  
  171. -------------------
  172. File Viewer Window:
  173. -------------------
  174.           This window pane lets you view the source file that references
  175.           the current token. This window pane is located in the lower
  176.           portion of the window.
  177.  
  178.           Special Keys in this window pane:
  179.           --------------------------------------------------------------
  180.              UP, DOWN, PAGE UP, PAGE DOWN:  Scroll the currently displayed file.
  181.  
  182.              ENTER:                         Query the database for the
  183.                                             referenced token. If a match
  184.                                             is found, this identifier is
  185.                                             entered into the History List box.
  186.  
  187.              Tab:                           Move cursor to the Reference List Box.
  188.  
  189.              Left Mouse:                    Display reference for the token
  190.                                             to which the cursor is pointing.
  191.  
  192.              Right Mouse:                   Same as "Left Mouse"; also add
  193.                                             current reference to the History
  194.                                             List.
  195.  
  196.  
  197. ------------------ CHAPTER 2 Working with Borland IDE. -------------
  198.  
  199.           This software is designed to work with Borland IDE. You can
  200. output the reference list items into the message window of IDE.
  201.  
  202. Here's how you do it:
  203.  
  204. PART A:  Install "ixref" into IDE.
  205.  
  206.            1) From within IDE, select the "Options->Transfer..." menu.
  207.  
  208.            2) Move to the last item in the "Program Titles" pane.
  209.  
  210.            3) Press the "Enter" key.
  211.                 You are now in the "Modify/New Transfer Item" dialog box.
  212.  
  213.            4) Under 'Program Title', enter "I~Xref".
  214.  
  215.            5) Under 'Program Path', enter "ixref".
  216.  
  217.            6) Under 'Command Line', enter "$PROMPT $CAP MSG(GREP2MSG)".
  218.  
  219.            7) Click on the "New" Button.
  220.               You are now in the "Transfer" dialog box.
  221.  
  222.            8) Click on the "OK" Button.
  223.                   You are now in the main IDE screen.
  224.  
  225.  
  226.  
  227. PART B:  Interactively use "ixref" with Borland IDE.
  228.  
  229.            9) Press "Alt-Space" or select the system menu icon.
  230.  
  231.           10) Press "x" or select "ixref" item.
  232.               A dialog prompts you for the "Program Arguments".
  233.  
  234.           11) Enter your program arguments. (e.g. "*.h *.c *.cpp")
  235.  
  236.           12) Click on the "OK" Button.
  237.                   You are transferred to the 'ixref' program.
  238.  
  239.           13) Query the identifiers, etc....
  240.  
  241.           14) Select "File" - "Exit out ref".
  242.               You are now back in IDE. The last item you referenced
  243.               should now be in the message window.
  244.  
  245.  
  246.         You may find the following book helpful in designing and
  247. using the Interactive Cross Referencing tool with IDE:
  248.  
  249.                 Borland IDE user manual
  250.  
  251.  
  252.  
  253.  
  254.  
  255. APPENDIX A. Quick References.
  256. -----------------------------
  257.  
  258. Keys        Context                Functions
  259. -----------------------------------------------
  260. Tab                                Move cursor to next window pane or dialog box item
  261. Enter       File Viewer            Query for the word under the cursor
  262. Enter       Ref ListBox            Add current reference to History Box
  263. Enter       Ident ListBox          Add current Identifier to History Box
  264.  
  265.  
  266.  
  267. Keys        Menu Command        Functions
  268. -----------------------------------------------
  269. Alt-X       File Exit           Quit program
  270. F1                              Help
  271. F2          File Save           Save cross reference database
  272. F3          File Open           Open cross reference database
  273. F4          File New            Open new database
  274. F5          Window Zoom         Zoom/unzoom current window
  275. F6          Next Window         Select next window
  276. F8          Misc Add            Add more source to current database
  277. F10                             Go to system menu
  278. Alt-F3                          Close current database window
  279.  
  280. Alt-F                           Select File menu
  281. Alt-W                           Select Window menu
  282. Alt-M                           Select Misc menu
  283.  
  284.  
  285.  
  286.